Pro-Cloud API Web Service
Method/ProCloudWS.asmx/ScheduledTasksOnlyReport
Pro-Cloud API Web Service > All Operations Resource Group : /ProCloudWS.asmx/ScheduledTasksOnlyReport (Method)
Description

This web method returns the details of any maintenance tasks that have been setup against an asset

Request (ScheduledTasksOnlyReportSoapIn)

The request body is of type ScheduledTasksOnlyReport.

Request Body Parameters

NameDescriptionData Type

This is a unique provider id, which can be obtained from CSS

GUId

guid

This is your unique service password which can be obtained from CSS

String (min 1 max 50)

xml:string

This is to filter by a particular branch ID

Int (using 0 will return results for all branches)

xml:int

This is to filter by a particular contract ID

Int (A contract ID must be used)

xml:int

This is the product code of your asset.

String (max 50 - an empty string can be sent for no filtering)

xml:string

This is the client name whom an asset is currently with. Is also a wild card search.

String (max 100 - an empty string can be sent for no filtering)

xml:string

This is the time frame you can filter your tasks by. Must be supplied

String (max 2 - T = Today; W = This Week; M = This Month; Y = This Year; LY = Last Year)

xml:string

This is a filter to return only tasks that are overdue

Boolean

xml:boolean

This is a filter which will return only completed or incomplete tasks

Int (0 =  All statues; 1 = Only complete; 2 = Only incomplete)

xml:int

This is a filter which will return tasks assigned to a particular agent/technician ID

int (-1 will return all agents)

xml:int

This is a filter which will return tasks assigned to a particular address ID

int (-1 will return all addresses)

xml:int

This is a filter which will return all tasks by a particular Asset ID

String (Max 50 - An empty string will return all assets)

xml:string

This is a filter which will return only tasks that have passed their checks

Boolean

xml:boolean

This is a filter which will return only tasks that have failed their checks

Boolean

xml:boolean

This is a filter which will return only tasks that repeat at the chosen interval

Int (-1 = All intervals; 1 = Daily; 2 = Weekly; 3 = Fortnightly; 4 = Monthly; 5 = 3 Monthly; 6 = Yearly; 7 = Ad-Hoc)

xml:int
intFrequencyFilter Element boolOnlyFailed Element boolOnlyPassed Element strAssetId Element intAddressId Element intTechnicianId Element intOnlyComplete Element boolOverDueOnly Element strTimeFrame Element strClient Element strProductCode Element intContractId Element intProviderBranchId Element strPassword Element objProviderGUId Element Sequence ScheduledTasksOnlyReport Element

Overview

Sequence
strPassword optional xs:string
strProductCode optional xs:string
strClient optional xs:string
strTimeFrame optional xs:string
boolOverDueOnly xs:boolean
strAssetId optional xs:string
boolOnlyPassed xs:boolean
boolOnlyFailed xs:boolean
Response (ScheduledTasksOnlyReportSoapOut)

The response body is of type ScheduledTasksOnlyReportResponse.

Response Body Parameters

NameDescriptionData Type
 objScheduledTasksOnlyReportReturn
xmlDataSet Element strErrorMsg Element intErrorId Element Sequence ScheduledTasksOnlyReportResult Element Sequence ScheduledTasksOnlyReportResponse Element

Overview

Sequence
Sequence
intErrorId xs:int
strErrorMsg optional xs:string
xmlDataSet optional
Sequence
Any
Example
<?xml version="1.0" encoding="UTF-8"?>
<objScheduledTasksOnlyReportReturn xmlns="http://pro-cloud.org/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<intErrorId>0</intErrorId>
	<strErrorMsg/>
	<xmlDataSet>
		<NewDataSet xmlns="">
			<ScheduledTasksOnlyReport>
				<AssetId>008-20367</AssetId>
				<AssetCode>BCYA</AssetCode>
				<IntervalDays>28</IntervalDays>
				<PPMDesc>BCYA - B06M </PPMDesc>
				<NextDue>2017-03-10T00:00:00+00:00</NextDue>
				<DaysToGo>2</DaysToGo>
				<LastTask/>
				<ManifestDate>2999-01-01T00:00:00+00:00</ManifestDate>
				<ServiceAddressOrClient/>
				<ItemCompStatus>0</ItemCompStatus>
				<ByUserId>-1</ByUserId>
				<ActivityId>350835</ActivityId>
				<typeId>18</typeId>
				<ActivityCompDate>2999-01-01T00:00:00+00:00</ActivityCompDate>
				<FullAddress/>
				<ReasonCodeTypeId>-1</ReasonCodeTypeId>
				<PlannedNext>2017-04-07T00:00:00+01:00</PlannedNext>
				<TaskDescription>B06 Monthly Test - BA Cylinder</TaskDescription>
				<ProviderBranchId>60</ProviderBranchId>
				<ItemManifestToId>-1</ItemManifestToId>
				<ItemManifestedTo/>
				<ActOutComeId>-1</ActOutComeId>
				<ActOutComeName/>
				<ActOutComeDescription/>
				<IsFailure>false</IsFailure>
				<StatusId>2539</StatusId>
				<LocationName>Nearside front</LocationName>
				<LocationParentId>2534</LocationParentId>
				<ParentName>D04P2</ParentName>
				<ParentId>2534</ParentId>
				<LocationBreadCrumb>D04P2 / Nearside front</LocationBreadCrumb>
				<LegacyStockRef>BCYA 76089</LegacyStockRef>
				<Description>BA Cylinder</Description>
				<ActivityItemId>458922</ActivityItemId>
			</ScheduledTasksOnlyReport>
		</NewDataSet>
	</xmlDataSet>
</objScheduledTasksOnlyReportReturn>
See Also
All Operations Resource GroupPro-Cloud API Web Service